home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / prog / vset10.arj / __001.EXE / MANUAL.DOC < prev    next >
Text File  |  1994-03-25  |  40KB  |  901 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                              Visible::Setup(tm)
  10.                             --------------------
  11.  
  12.            developers' installation utility for DOS applications
  13.  
  14.  
  15.  
  16.  
  17.                          a product of RCCO Research
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26. The Bottom Line
  27. ----------------
  28. The following is a quick summary of steps that will be taken by the developer
  29. to create an installation sequence with Visible::Setup(tm):
  30.  
  31.   ┌────────────────────────────────────────────────────────────────────────┐
  32.   │                                                                        │
  33.   │ 1. You will create a self-extracting archive file named __001.EXE      │
  34.   │    with LHA (included), PKSFX, or similar programs; __001.EXE will     │
  35.   │    contain all your program's files that are to be installed on an     │
  36.   │    end-user's machine.                                                 │
  37.   │                                                                        │
  38.   │ 2. Your program's documentation must be named MANUAL.DOC and must      │
  39.   │    be included within the __001.EXE package.  MANUAL.DOC should be     │
  40.   │    plain ASCII text, suitable for printing to PRN from the DOS         │
  41.   │    prompt.                                                             │
  42.   │                                                                        │
  43.   │ 3. If you wish your program and/or company names to be displayed       │
  44.   │    on the opening screen banner and elsewhere in your installation,    │
  45.   │    create a one-line ASCII text file named _ADMIN.DAT that contains    │
  46.   │    nothing other than that which you wish displayed (ie, "MEGA-APP     │
  47.   │    by XYZ SOFTWARE").                                                  │
  48.   │                                                                        │
  49.   │ 4. Copy __001.EXE, the optional _ADMIN.DAT, and a copy of INSTALL.EXE  │
  50.   │    (the Visible::Setup program) to the root directory of your master   │
  51.   │    distribution diskette, along with any other files (ie, those not    │
  52.   │    included inside __001.EXE) you wish to be included on each distrib- │
  53.   │    uted disk:  README.TXT, FILE_ID.DIZ, VENDOR.DOC, etc.               │
  54.   │                                                                        │
  55.   │ 5. Change to the drive containing your newly created master distribu-  │
  56.   │    tion disk, and type INSTALL <enter> to test your firm's new         │
  57.   │    installation routine.                                               │
  58.   │                                                                        │
  59.   └────────────────────────────────────────────────────────────────────────┘
  60.  
  61.  
  62.  
  63.  
  64.  
  65. MANUAL.DOC              Visible::Setup(tm)  Documentation              Page 2
  66.  
  67.  
  68.  
  69. Capabilities
  70. -------------
  71. Visible::Setup(tm) is a simple, basic install utility for DOS applications.
  72. It is easier for the developer to configure an installation sequence with
  73. Visible::Setup than with batch files (ie, the much-maligned 'install.bat'),
  74. yet far more elegant and professional in execution and appearance.  In
  75. utilizing Visible::Setup, there is no scripting language to learn, there
  76. are no scripts or macros to write, nor are there unusual setup practices
  77. that deviate from customary, familiar usage in the DOS environment.
  78. Visible::Setup provides a clean, professional image to all application
  79. installations.
  80.  
  81. While there are many available install programs for use by developers, all
  82. of which claim easy configuration, in practice they sometimes have inherent
  83. eccentricities that are inappropriate for use in many applications; often,
  84. a garish overuse of color mix and screen images irrelevant to the task at
  85. hand is prevalent (even in expensive commercial installation programs) and
  86. is often simply not appropriate in professional development environments.
  87.  
  88. End-users, experienced or not, performing such resulting installations are
  89. often confused and (rightly) concerned about current operations being carried
  90. out on their machines.  Each new instance of the configuration process for
  91. the developer is often needlessly proprietary, time-consuming, and unwel-
  92. comed.
  93.  
  94. Visible::Setup attempts to minimize such concerns, distractions, and eccen-
  95. tric feature sets; it does this by offering the most simple solution possible
  96. to the program installation process.  The tradeoff for such simplicity is
  97. that elaborate custom configurations on destination computers are not approp-
  98. riate with this utility, other than those which may be carried out discretely
  99. via a developer-created batch file option (see below).
  100.  
  101. Color usage and screen text formatting is clean, simple, and intentionally
  102. compatible with traditional DOS text, as the program makes judicious use of
  103. DOS services (inherent in command.com) during the installation process.
  104. Colors, attributes, and screen prompts are specifically designed to be
  105. usable and visible on all color, monochrome, and laptop/notebook displays.
  106.  
  107. Visible::Setup is used in conjunction with any of the widely available
  108. archiving/compression programs that produce a self-extracting compressed
  109. file.  The examples in this documentation use the LHA file-compression
  110. program by Haruyasu Yoshizaki, considered by many developers as an accepted
  111. standard for professional use (ie, several of the large commercial software
  112. publishers use LHA, particularly for demo installations, because of its
  113. speed, reliability, and ease of setup).  A copy of LHA.EXE is provided for
  114. evaluation within the current package.  Other compression programs that
  115. produce self-extracting archive files may be used as well within
  116. Visible::Setup, as long as the resulting compressed filename extension
  117. is .exe.
  118.  
  119. The unregistered evaluation version of Visible::Setup, provided herewith,
  120. is fully functional.  Its limitation provides for installations that will
  121. fit on a single install diskette (360k, 720k, 1.2mg, 1.44mg - as needed).
  122. The registered copy version provides for installations that span multiple
  123.  
  124.  
  125.  
  126. MANUAL.DOC              Visible::Setup(tm)  Documentation              Page 3
  127.  
  128.  
  129. disks in any single installation set.  Visible::Setup provides advantages
  130. for the commercial developer in that, upon payment of a very nominal
  131. registration fee (currently $19.95), it may included and distributed with
  132. multiple applications legally and without further license, restriction, or
  133. payment of runtime royalties.
  134.  
  135. The demonstration for the Visible::Setup program is provided by performing
  136. an installation of itself.  The potential developer user of this product
  137. may begin evaluation of Visible::Setup by observing its installation:
  138. the developer's resulting installations will have similar execution and
  139. appearance.
  140.  
  141. Visible::Setup(tm) may be used with most traditional MS-DOS language ins-
  142. tallations, including those created with CA-Clipper, Borland Turbo Pascal,
  143. QuickBASIC, PowerBasic, Visual Basic(tm) for DOS, dBase, Clarion, C, etc.
  144. It is small, efficient, and executes cleanly and swiftly from DOS (or a DOS
  145. box in Windows(tm) ).  Its small file size (about 16k, not compressed)
  146. provides for minimal space usage on distribution disks.
  147.  
  148. Visible::Setup may well be particularly appropriate for corporate developers
  149. transmitting applications to remote locations.
  150.  
  151. Visible::Setup(tm) installations will run under both DOS and Windows(tm).
  152. The chief advantages, aside from those described above, are both low cost
  153. and method of acquiring.  The copy included herewith is a fully-functional
  154. evaluation copy available easily and universally through the user-supported
  155. software marketplace.
  156.  
  157.  
  158.  
  159.  
  160. Self-installation is the demonstration
  161. ---------------------------------------
  162. To observe the demonstration of how Visible::Setup works and appears, simply
  163. install Visible::Setup to your hard disk by logging on to the drive contain-
  164. ing the installation files, then typing:
  165.  
  166.                            INSTALL <enter>
  167.  
  168.  
  169. If the program has been downloaded from a BBS or information service, you
  170. may run INSTALL.EXE from your downloads directory if you are installing to
  171. a *different* logical drive from the one in which INSTALL.EXE exists.  (You
  172. may wish to include this paragraph or something similar regarding downloads
  173. in your README.TXT file for your own installations.)
  174.  
  175. The install process will create a directory on the destination drive if it
  176. does not already exist, the default selection being  \PROGRAMS  (please feel
  177. free to specify a different directory name).  The install process does not
  178. modify the path, autoexec.bat, or config.sys.
  179.  
  180. Before the end of the installation, an optional developer-defined batch file
  181. named '_setup.bat' is called discretely and unobtrusively.  In the installa-
  182. tion of Visible::Setup itself, _setup.bat occurs as a simple page of text
  183. to show when and where it might appear in the install process, should the
  184.  
  185.  
  186.  
  187. MANUAL.DOC              Visible::Setup(tm)  Documentation              Page 4
  188.  
  189.  
  190. developer wish to make use of such a batch file for special configurations,
  191. operations, or welcome messages, etc.  _Setup.bat is deleted from the
  192. directory after execution, so that the end-user is not ordinarily aware of
  193. its existence or use.  In other installation instances, should a _setup.bat
  194. file be found not to exist, the installation simply ends appropriately at
  195. this point.
  196.  
  197. If the user is logged *onto* the source drive when launching INSTALL.EXE,
  198. the developer's program name and company name are read from an optional file
  199. named '_admin.dat' and is displayed on the opening screen as a banner, and
  200. on the second screen which requests info as to the source drive, and again
  201. on the very final screen.  If the user is not logged onto the source drive
  202. when launching INSTALL (ie, the user typed A:INSTALL from the C: drive or
  203. elsewhere other than the source drive), the names are displayed only on the
  204. final screen as part of the epilogue.  In this instance, an _admin.dat file
  205. must be present on the source drive for the names to be displayed.  Please
  206. note that the use of _admin.dat is entirely optional.
  207.  
  208.  
  209.  
  210.  
  211.  
  212. Preparation of files to be installed
  213. -------------------------------------
  214. There are two required appropriately-named files that must exist for use
  215. with Visible::Setup.  There must be a self-extracting compressed archive
  216. file named
  217.  
  218.                            __001.EXE
  219.  
  220. containing all the files the developer wishes installed on end-users'
  221. machines.
  222.  
  223. We utilize the unusual naming convention (__001.EXE) for archive files in
  224. order to discourage inadvertant launching of the extraction process by an
  225. end-user at an inappropriate time (ie, on a floppy diskette with insufficient
  226. space for decompressed files).   We have found this naming practice to work
  227. quite well in many of our own commercial applications of recent years.
  228.  
  229. The Visible::Setup disk identification procedure tests for the presence of a
  230. file named __001.EXE; without the presence of such a file, the end-user will
  231. be prompted for insertion of the installation disk in the specified source
  232. drive.
  233.  
  234. Inside the __001.EXE must exist the other required file:
  235.  
  236.                            MANUAL.DOC
  237.  
  238. The MANUAL.DOC ordinarily contains your program information and instructional
  239. material for end-users.  Each instance of an install with the Visible::Setup
  240. program will check for the existence of a file called MANUAL.DOC in the des-
  241. tination directory as part of the verification of successful completion of
  242. installation.  The installation also prompts the end-users as to whether or
  243. not they wish to print out a copy of the program documentation on their
  244. printers.  In order for them to do that, the file must exist and it must be
  245.  
  246.  
  247.  
  248. MANUAL.DOC              Visible::Setup(tm)  Documentation              Page 5
  249.  
  250.  
  251. named MANUAL.DOC.  If it is absent, an error message will be displayed that
  252. informs them a file is missing; the installation process will exit at that
  253. point with a message indicating an incomplete installation.
  254.  
  255. MANUAL.DOC need not be elaborate or very long (even a single page will do),
  256. but it must be a plain ASCII text file suitable for printing to PRN from the
  257. DOS prompt (more about this further on).
  258.  
  259. Please note that MANUAL.DOC must be placed *inside* the __001.EXE package.
  260.  
  261.  
  262.  
  263. The _Setup.bat option
  264. ----------------------
  265. In addition to the developer's program files and the MANUAL.DOC, __001.EXE
  266. may contain a developer-defined batch file, named
  267.  
  268.                            _SETUP.BAT
  269.  
  270. as mentioned previously.
  271.  
  272. The use of a _setup.bat is optional, but is provided to afford the developer
  273. the opportunity for custom configurations or simply a personal welcome or
  274. thank you message for the end-user.  A _setup.bat may be used if the devel-
  275. oper needs to create subdirectories (and move files into such subdirector-
  276. ies), check config.sys settings or display critical messages (ie, 'Make
  277. certain the FILES= setting in your config.sys file is set to FILES=30 or
  278. greater') or provide initial operating instructions (ie, 'With the included
  279. copy of LIST.COM, you may read the documentation by typing LIST MANUAL.DOC
  280. and pressing Enter'), etc.
  281.  
  282. The _setup.bat need not display any message at all while it is performing
  283. custom configuration commands, but it may do so if the developer so wishes.
  284. It will execute as if normally executed from the DOS prompt in the direc-
  285. tory where the developer's program has just been installed.
  286.  
  287. The developer should exercise caution against attempting to launch large
  288. executable programs from within the _setup.bat sequence.  There can be no
  289. assurance that sufficient memory will be available for the child process on
  290. all potential users' machines.  _Setup.bat is intended primarily for calling
  291. on DOS functions found in command.com, ie, MD, COPY, DEL, etc.  Always return
  292. your end-users to the main program directory after performing your custom
  293. actions.  You should well test all events and all possible consequences of
  294. those events before distributing your programs.
  295.  
  296. _Setup.bat is deleted from the destination directory after its execution, so
  297. that the end-user would not ordinarily become aware of its existence or use
  298. by finding it in the program directory.  If, during any instance of an ins-
  299. tallation, a _setup.bat file is not found to exist, the installation ends
  300. appropriately and normally at that point.  In either situation, with or with-
  301. out the _setup.bat sequence, Visible::Setup then completes its function, with
  302. an on-screen indication to the end-user of a successful installation.
  303.  
  304. Please note that _setup.bat must be placed *inside* the __001.EXE package.
  305.  
  306.  
  307.  
  308.  
  309. MANUAL.DOC              Visible::Setup(tm)  Documentation              Page 6
  310.  
  311.  
  312. The _Admin.dat file option
  313. ---------------------------
  314. As mentioned previously, if a properly constructed file named '_admin.dat' is
  315. found on the source drive, Visible::Setup can display the developer's program
  316. name and/or company name at least once and normally three times during the
  317. installation.
  318.  
  319. _Admin.dat must be a plain ASCII text file consisting of one line only, with
  320. no more than 76 characters in the one line; it must be left-justified within
  321. _admin.dat.  It should appear similarly as follows:
  322.  
  323. MEGA-APP by XYZ SOFTWARE
  324.  
  325. although the content and format may of course be determined by the developer
  326. within the limitations described above.
  327.  
  328. You create an _admin.dat with your text editor or simply modify the sample
  329. one included with this package.  You then include a copy of _admin.dat in
  330. the root directory of your master installation disk 1.
  331.  
  332. During an installation, if the end-user is logged onto the source drive when
  333. launching INSTALL.EXE, ie,
  334.  
  335.                        A: <enter>
  336.                        INSTALL <enter>
  337.  
  338. the developer's program name and/or company name is read from the _admin.dat
  339. and is displayed on the opening screen as a banner, and on the second screen
  340. which requests info as to the source drive, and again on the very final
  341. screen that indicates a successful completion of the installation.  (Ex-
  342. pressed in another way, the location of _admin.dat must be in the current
  343. directory of the currently logged drive in order to be read into the install
  344. procedure.)
  345.  
  346. If the user is *not* logged onto the source drive when launching install,
  347. ie, the user typed:
  348.  
  349.                         A:INSTALL <enter>
  350.  
  351.                         (or
  352.                         B:INSTALL <enter>)
  353.  
  354. from the C: drive or elsewhere other than the source drive, the name(s) are
  355. displayed only on the final screen as part of the epilogue.  In this ins-
  356. tance, a proper _admin.dat file must be present on the source drive for the
  357. name(s) to be read by Visible::Setup and displayed as described.
  358.  
  359. We emphasize that _admin.dat must be plain ASCII text with no extraneous
  360. formatting codes, and consist of one line only.  We find that shorter line
  361. lengths, when appropriate, offer more suitable banner appearance than longer
  362. lines, even though technically you may have a line of up to 76 characters in
  363. length.
  364.  
  365. If you do not care to have the name(s) displayed at all, simply omit an
  366. _admin.dat file from your distribution disk 1.
  367.  
  368.  
  369.  
  370. MANUAL.DOC              Visible::Setup(tm)  Documentation              Page 7
  371.  
  372.  
  373.  
  374. Please note that _admin.dat is *not* placed inside the __001.EXE package,
  375. but rather in the root directory of your distribution disk 1.
  376.  
  377.  
  378.  
  379.  
  380.  
  381. Use of the LHA.EXE compression utility
  382. ---------------------------------------
  383. Within the Visible::Setup package should be found a copy of LHA.EXE, the
  384. freeware file compression program by Haruyasu Yoshizaki (Yoshi), for your
  385. evaluation.  This quality utility offers an excellent compression ratio and
  386. ease of use, along with a swift self-extracting mechanism appropriate for
  387. use in installation sequences.
  388.  
  389. The creation of the required __001.EXE (see above) with LHA is a two-step
  390. process.  First, the compression package is created by indicating the files
  391. desired within the archive; for example, one might enter at the DOS prompt:
  392.  
  393.    lha a __001 myapp.exe *.dbf MANUAL.DOC readme.txt order.frm _setup.bat
  394.  
  395. followed by pressing the <enter> key.  This creates an archive file named
  396. __001.LZH containing the files indicated after the '__001' parameter.  The
  397. first parameter after the 'lha' command is the letter 'a' which simply
  398. means ADD to an archive file named '__001' the filenames (separated by a
  399. space in each instance) that follow.  Conventional DOS wildcard characters
  400. may be used, as indicated in the sample above.
  401.  
  402. The one *required* file in the archive is capitalized above for emphasis:
  403.  
  404.                         MANUAL.DOC
  405.  
  406. in that it must be present in any Visible::Setup installation.  MANUAL.DOC
  407. need not be elaborate (see below for suggestions for MANUAL.DOC), but it
  408. must be present in all install setups that you create.
  409.  
  410. If you have a README.TXT that will appear on your distribution diskette,
  411. and you would like it to be found in the end-users' program directory as
  412. well, include a copy of it in the archive file, as indicated in the sample
  413. above.
  414.  
  415. If you subsequently need to add other names to this archive at a later
  416. time, the 'a' parameter is used again; ie,
  417.  
  418.                         lha a __001 *.ndx <enter>
  419.  
  420. adds all files ending in '.ndx' to the existing archive named __001(.LZH).
  421.  
  422. Similarly, to delete a file from the archive, you specify:
  423.  
  424.                         lha d __001 _setup.bat <enter>
  425.  
  426. and the file named '_setup.bat' is removed from the archive package.
  427.  
  428.  
  429.  
  430.  
  431. MANUAL.DOC              Visible::Setup(tm)  Documentation              Page 8
  432.  
  433.  
  434.  
  435. The __001.EXE file
  436. -------------------
  437. From the resulting archive file called __001.LZH you must then create a
  438. self-extracting archive file by typing:
  439.  
  440.                         lha s __001 <enter>
  441.  
  442. This will create a self-extracting form of the archive named __001.EXE, which
  443. will then be placed in the root directory of your master distribution disk 1
  444. for use by Visible::Setup.  You should NOT include a copy of LHA.EXE with
  445. your distribution disk(s), since the self-extracting file executes and
  446. decompresses your sequence of files on any DOS-compatible computer.
  447.  
  448.  
  449. Please simply note the required filename for the compressed file package:
  450. __001.EXE is made up of two underscore characters, followed by two zeros
  451. (*not* the letter 'O'), followed by the digit 1.
  452.  
  453.  
  454. (If the above LHA.EXE instructions are familiar and obvious to you, they
  455. may seem simplistic in our iteration of them in this document; please be
  456. mindful that they are *not* obvious to some users who may never have used
  457. the LHA utility before.)
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465. Maximum size for __001.EXE
  466. ---------------------------
  467. Take care not to allow the __001.EXE file to exceed the capacity of your
  468. intended distribution disk, minus about 20k (for the Visible::Setup
  469. executable file and miscellaneous files:  _admin.dat, readme.txt,
  470. file_id.diz, etc).  If the __001.EXE grows larger than available diskette
  471. space, either choose the next largest disk size for your master distribution
  472. diskette or obtain/utilize an authorized registered copy of Visible::Setup,
  473. which may span multiple disks when needed (with __002.EXE, __003.EXE, etc).
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492. MANUAL.DOC              Visible::Setup(tm)  Documentation              Page 9
  493.  
  494.  
  495. MANUAL.DOC suggestions
  496. -----------------------
  497. As mentioned previously, the required file named MANUAL.DOC need not be
  498. elaborate or lengthy, although it may of course be both.  This is entirely
  499. up to the developer and the requirements of each particular application.
  500. In a Visible::Setup installation, MANUAL.DOC may be as short as one
  501. page in length, but it must indeed exist.
  502.  
  503. MANUAL.DOC should be plain ASCII text created with a text editor or with a
  504. word processor capable of saving files as plain ASCII text.  Line length
  505. should never exceed 79 characters and the text itself must never carry any
  506. invisible formatting codes other than the formfeed character (Alt-12).  Be
  507. particularly cautious not to include the arrow characters (Alt-24, 25, 26,
  508. 27) in diagrams or other parts of the documents, as you could easily abort
  509. the document printing process for the end-user during installation or at
  510. other times.  Be mindful that certain line-drawing or box characters may
  511. not print appropriately on non-graphics printers; we include them in our
  512. own documents, but use them judiciously with the assumption that our intend-
  513. ed audience has the appropriate hardware capability.
  514.  
  515. MANUAL.DOC should be generically formatted for proper appearance when printed
  516. to PRN from the DOS prompt.  Such basic format should include pagination and
  517. proper formfeeds.  An easy way to prepare this is to use two commonly
  518. available utilities:  PC Magazine's PRN2FILE.COM and Peter Norton's "Line
  519. Print" program, LP.EXE.  You load PRN2FILE, a TSR, to direct all print com-
  520. mands ordinarily sent to LPT1 to a specified disk file (perhaps, for example,
  521. to TEMP.TXT).  You then issue an instruction to LP.EXE to "print" a copy of
  522. your unformatted MANUAL.DOC with a 0 left margin.  After PRN2FILE writes
  523. this print run to a disk file, you will have a newly formatted copy of your
  524. MANUAL.DOC suitable for printing to PRN from the DOS prompt.  You may need
  525. to edit the resulting copy slightly or experiment with moving paragraphs
  526. down or up in your original copy in order to get an acceptable final copy,
  527. but these operations take only minutes and are well worth the end result.
  528.  
  529. You may wish to make note in your README.TXT file (which may be included in
  530. the root directory of your master distribution disk 1), that end-users will
  531. be given an opportunity to print out the program documentation during the
  532. installation process.  You should also inform them of the number of pages in
  533. the documentation, so that they may ready their printers with an adequate
  534. supply of paper.  We have found, over and over during recent years, that
  535. many users very much appreciate the opportunity to print out program documen-
  536. tation, from either the installation or within the application itself.  You
  537. might be mindful of your potential clientele and the fact that there are
  538. many computer users that are uncomfortable with, or perhaps unknowledgeable
  539. of (even with specific instructions), issuing a simple DOS command such as
  540. "TYPE MANUAL.DOC > LPT1."
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553. MANUAL.DOC              Visible::Setup(tm)  Documentation             Page 10
  554.  
  555.  
  556.  
  557. The master distribution disk(s)
  558. --------------------------------
  559. After the required files are readied, you need only to copy them to the
  560. root directory of your master distribution disk(s).  The files will include:
  561.  
  562.                      INSTALL.EXE  (the Visible::Setup executable file)
  563.                      __001.EXE    (self-extracting compressed file)
  564.                      _ADMIN.DAT   (optional program/company names file)
  565.  
  566. as well as other files you might wish to be distributed, for example:
  567.  
  568.                      README.TXT
  569.                      FILE_ID.DIZ
  570.                      VENDOR.DOC   (or INFO.TXT)
  571.                      ORDER.FRM    (perhaps should be inside __001.EXE)
  572.  
  573.                      etc.
  574.  
  575.  
  576. If using an authorized copy of the registered version of Visible::Setup,
  577. you will have multiple-disk set capacities.  Disk 2 would contain __002.EXE,
  578. Disk 3 __003.EXE, etc.  Simply plan and adjust your __00?.EXE files to fit
  579. properly on the intended size of distribution diskettes.  The registered
  580. version also makes provision for the developer to specify a different name
  581. for the suggested default destination directory for each application, rather
  582. than only the '\PROGRAMS' default suggested in the present version.
  583.  
  584. If you find that disk space on distribution disk 1 is not enough, the
  585. INSTALL.EXE can usually be compressed with the LZEXE.EXE utility by Fabrice
  586. Bellard.  We caution that other .exe compression programs may not work well
  587. in this instance.
  588.  
  589. Please note that all required files should be placed in the root directory
  590. of your distribution disk(s).
  591.  
  592.  
  593.  
  594.  
  595. The sequence of events during an installation
  596. ----------------------------------------------
  597. When the user has launched INSTALL.EXE from the DOS prompt (or a DOS box in
  598. Windows), a splashcreen is displayed prompting the user to press <Enter> to
  599. initiate the installation process.
  600.  
  601. The following screen prompts for the letter of the source drive containing
  602. the installation Disk 1, with the default suggesting Drive A:.  The user
  603. may press any letter corresponding to the available DOS drives on the
  604. computer, or may simply press <Enter> to accept the default.  INSTALL will
  605. use the currently logged directory on the source drive, which is normally
  606. the root on a floppy drive or, if installing from a hard drive (or a ram
  607. drive), the current directory from which INSTALL was launched.  If the user
  608. presses <Esc> at this point, the install program will exit and return to
  609. the system.
  610.  
  611.  
  612.  
  613.  
  614. MANUAL.DOC              Visible::Setup(tm)  Documentation             Page 11
  615.  
  616.  
  617. After the source drive prompt, a screen prompting for the destination drive
  618. is displayed.  It will be indicated to the user that the source drive and
  619. destination drive must be different.  Again, the user presses a letter key
  620. corresponding to an available drive letter, or presses <Enter> to accept the
  621. default, which is hard drive C:.  <Esc> at this point will exit the install
  622. process.
  623.  
  624. The next screen prompts for a destination directory on the previously chosen
  625. destination drive.  The suggested default is \PROGRAMS (the registered ver-
  626. sion provides for the developer to change the directory name to another sug-
  627. gested default), but the user is free to enter any directory name, either
  628. existing or needing to be created, allowable under DOS naming conventions.
  629. If the user enters an inappropriate name, an error message will be displayed
  630. with a suggestion for proper naming procedures allowed under DOS.  For exam-
  631. ple, a common error might be to enter a second subdirectory,
  632.  
  633.                                  \DIR1\DIR2
  634.  
  635. when \DIR1 does not prior exist.  For such users, the error message suggests
  636. they enter a DOS-allowable directory name or simply accept the default direc-
  637. tory name suggested by INSTALL.
  638.  
  639. The next screen displays information that the installation has begun and
  640. offers other informative messages as the process proceeds.  The occurrence
  641. here is one of copying the __00?.EXE files from the source drive to the
  642. destination directory, unarchiving the compressed files, and removing the
  643. __00?.EXE files from the program directory.  Part of the verification
  644. process includes checking for the presence of the file MANUAL.DOC at this
  645. point; if this key file is missing, the user is informed of an incomplete
  646. installation, and returned to the system with suggestions as to possible
  647. solutions to the problem that occurred.  The developer must ascertain that
  648. omitting a MANUAL.DOC from the package will never be a cause for the end-
  649. user seeing this message.
  650.  
  651. After the verification, the user is presented with a new screen prompting
  652. that the documentation may be printed out and would they indicate by a
  653. <Y> or <N> response whether or not they wish to print the documentation.
  654. If the user answers <N>, the install process continues to the next event.
  655. If the user presses <Y>, a second prompt will ask the user to verify that
  656. the printer is on, top of page aligned, and that there is sufficient paper
  657. in the printer.  Again, the response must either be <Y> or <N>.  If <N>,
  658. INSTALL discontinues the print request and proceeds to the next event.
  659. If the user again responds <Y>, the file MANUAL.DOC is typed to the output
  660. device PRN, along with an appropriate screen message to the user that the
  661. printing process is underway.
  662.  
  663. Next, INSTALL checks the program directory for the existence of a _setup.bat
  664. file, which would have been placed in that directory from within the
  665. __001.EXE package.  If _setup.bat is not found, INSTALL procedes to the next
  666. event (the final screen).  If it is found, it is immediately executed as a
  667. process that appears to the end-user as part of the ongoing installation
  668. sequence.  Often the _setup.bat need only carry a welcome or thank you
  669. message from the developer to the end-user.  The developer should well
  670. consider the significance and advantages that such well-placed messages
  671. may convey to the client.  Note: a clearscreen precedes the _setup.bat call.
  672.  
  673.  
  674.  
  675. MANUAL.DOC              Visible::Setup(tm)  Documentation             Page 12
  676.  
  677.  
  678.  
  679. The final screen indicates to the end-user successful completion of the
  680. installation procedure and a return to the system prompt, in the program
  681. directory.
  682.  
  683.  
  684.  
  685.  
  686.  
  687. Precautions
  688. ------------
  689. The only caveat we might offer with Visible::Setup is to make sure that
  690. the optional _SETUP.BAT (the extension is .Bat for batch) file is placed
  691. *inside* the __001.EXE package, while the optional _ADMIN.DAT (the extension
  692. is .Dat for data) file is placed in the root directory of your distribution
  693. disk 1.  Keep in mind also that the file named MANUAL.DOC is used as a
  694. key file for verification purposes; do not neglect to always include such
  695. a file inside one of your __00?.EXE packages.
  696.  
  697.  
  698.  
  699.  
  700.  
  701. Program Requirements
  702. ---------------------
  703. The requirements for creating Visible::Setup(tm) installation sequences
  704. include a DOS-compatible PC with 512k memory.  DOS 3.1 (or later) or
  705. Windows 3.x (or greater) should be utilized.
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712. The Unregistered Evaluation Copy
  713. ---------------------------------
  714. The unregistered version of this program is intended for use in evaluation
  715. situations.  It may be used for ninety (90) days within your own organ-
  716. ization by persons that have knowledge and understanding of the fact that
  717. it is an unregistered evaluation copy.
  718.  
  719. The payment of the $19.95 purchase price for a registered copy of this
  720. program will allow license for a single user to make use of the program for
  721. purposes that are traditionally accepted for software utilities of this
  722. type.  Additional site license fees of $10.00 per user may be paid at the
  723. time of registration, or any time in the future after initial registration
  724. at the then current license fee in effect.  There are no runtime royalties
  725. involved in the distribution of your materials utilizing a duly registered
  726. copy of Visible::Setup(tm).
  727.  
  728. The license and authorized registration shall not be construed as being
  729. in effect until direct payment has been received by RCCO Research and an
  730. authorized, registered copy has been sent in the registered user's/users'
  731. name(s).
  732.  
  733.  
  734.  
  735.  
  736. MANUAL.DOC              Visible::Setup(tm)  Documentation             Page 13
  737.  
  738.  
  739.  
  740. The Registered Version of Visible::Setup(tm)
  741. ---------------------------------------------
  742. The registered copy performs functionally similar to the evaluation copy, and
  743. includes specific copies of INSTALL.EXE that provide for multiple-disk set
  744. installations, up to and including four- (4-) disk installations. The maximum
  745. size of each __00?.EXE must be limited to that which will fit on the intended
  746. size of the distribution disks (ie, for 360k disks each __00?.EXE must not
  747. exceed 360k or the next largest disk size should be utilized throughout the
  748. set).
  749.  
  750. If you require a version of Visible::Setup that provides for a multiple-disk
  751. setup greater than four disks, we can provide a custom build of INSTALL.EXE
  752. for a very nominal fee.  We can also make a custom build that omits the docu-
  753. mentation printing sequence, for those developers that have pre-printed
  754. materials.  (Please write for a quotation, indicating the specific number of
  755. install disks required in your application plus any other specifications.)
  756. Such custom builds may be obtained with, or after, the initial registration
  757. of the program.
  758.  
  759. The registered version also makes provision for the developer to specify a
  760. different name for the suggested default destination directory for each
  761. application, rather than only '\PROGRAMS' as suggested in the evaluation
  762. copy.  With that provision, each new application that goes out may have
  763. a developer-defined suggestion for the destination program directory.
  764.  
  765. Documentation for the registered version is an on-disk text file, similar to
  766. the present format.
  767.  
  768. Your registered version disk (either 360k 5.25" or 720k 3.5", please specify)
  769. will contain authorized, serialized copies of the latest version of the
  770. Visible::Setup program along with license to distribute with your own appli-
  771. cations without undue restriction or payment of runtime royalites.
  772.  
  773. Any upgrade versions will be offered to registered users at significant
  774. reduction (generally about 50%) from the then current registration fees.
  775.  
  776.  
  777.  
  778. Licensing Information
  779. ----------------------
  780. This program is licensed and supplied as is, without any warranty.  To the 
  781. extent permitted under applicable law, RCCO Research Associates disclaims 
  782. all warranties, either expressed or implied, with respect to this software 
  783. program, its quality, performance, merchantability, or fitness for any 
  784. particular purpose.
  785.  
  786. In particular, this software program is not guaranteed to prevent or detect
  787. damage to your data or programs.  In no event shall RCCO Research Associates
  788. be liable for any claims for lost profits or any damage, including, but not
  789. limited to, special, incidental, consequential or other damage (including, 
  790. without limitation, damages for loss of business profits, business interrup-
  791. tion, loss of business information, or other pecuniary loss) arising out of
  792. the use of or inability to use this RCCO Research Associates product, even
  793. if RCCO Research Associates has been advised of the possibility of such
  794.  
  795.  
  796.  
  797. MANUAL.DOC              Visible::Setup(tm)  Documentation             Page 14
  798.  
  799.  
  800. damages.  Some states do not allow the exclusion or limitation of incidental
  801. or consequential damages, so the above limitation or exclusion may not apply
  802. to you.  In no case shall RCCO Research Associates's liability exceed the
  803. license fees paid for the right to use the licensed version of the software. 
  804.  
  805. The license agreement and warranty shall be construed, interpreted and
  806. governed by the laws of the state of Tennessee.
  807.  
  808. This software program is protected under the Copyright Laws of the United 
  809. States of America and all applicable International Copyright Conventions.  
  810. Makers and/or users of illegal or unauthorized copies of the registered 
  811. version are subject to prosecution under these laws.
  812.  
  813. The name  Visible::Setup(tm)  is a trademark of RCCO Research Associates.
  814. Windows(tm) is a trademark of Microsoft Corporation.
  815.  
  816.  
  817.  
  818.  
  819.  
  820. Registration Notes
  821. -------------------
  822. Registration will obtain a copy of the most recent authorized version and
  823. provide legal authorization for continued use of the program after the
  824. ninety-day (90-day) evaluation period.
  825.  
  826. To obtain a registered copy, you must mail an advance-payment registration
  827. fee of U.S. $19.95 + $2.55 shipping/handling ($7.00 non-U.S. shipping/
  828. handling) directly to RCCO Research.  Payment is to be made by check or
  829. money order only, please.  We require payment with order so that prices
  830. and fees may be kept as reasonable as possible; this policy has worked well
  831. for us in recent years, as we observe increased registration on products
  832. that are reasonably priced.
  833.  
  834. An invoice will be included with your order, showing the registered serial
  835. number(s) applicable to the purchase.  We can provide a pro forma invoice
  836. to those corporations or institutions that require same before payment can
  837. be issued; shipment will be made promptly upon receipt of payment.  Prices
  838. and/or registration and/or license fees are subject to change.
  839.  
  840. Tennessee clients please include the required 8.5% sales tax on both the
  841. product amount and shipping/handling as mandated by the state.
  842.  
  843. International clients must pay by check or money order in U.S. dollars,
  844. drawn on a U.S. bank.  Please realize that international money orders are
  845. considerably delayed through the postal systems and may not be the most
  846. expedient way of relaying payment.
  847.  
  848. Please indicate program name and current version number on your order; you
  849. may use the Order.frm file provided on the disk (or the program directory)
  850. or simply send a note or letter with your name, organization name, address,
  851. program name & version, number of users being licensed, and remittance.
  852. Your comments on our programs are welcomed.
  853.  
  854.  
  855.  
  856.  
  857.  
  858. MANUAL.DOC              Visible::Setup(tm)  Documentation             Page 15
  859.  
  860.  
  861. Additional Information
  862. -----------------------
  863. If you have any comments regarding this program after (or with) registra-
  864. tion, please send them in writing to:
  865.  
  866.                               RCCO Research Associates
  867.                               P. O. Box 196
  868.                               Gatlinburg, TN 37738
  869.  
  870. Please include your phone (day & evening) and fax (if any) numbers as well
  871. as your mailing address on ALL written communications.  Please indicate the
  872. serial number from your copy of the program as well as your CustID number.
  873.  
  874.  
  875.  
  876.  
  877.  
  878.  
  879.  
  880.  
  881. Visible::Setup(tm)
  882. -------------------
  883. developers' installation utility for DOS applications
  884.  
  885.  
  886.  
  887. (C) Copyright 1994 RCCO Research Associates
  888. All Rights Reserved under International Conventions
  889. Product of U.S.A.
  890.  
  891.  
  892.  
  893. RCCO Research Associates
  894. Post Office Box 196
  895. Gatlinburg, Tennessee 37738
  896.  
  897.  
  898.  
  899.  
  900.  
  901.